home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audiofile / AFgetmarkids.z / AFgetmarkids
Encoding:
Text File  |  1998-10-20  |  4.5 KB  |  133 lines

  1.  
  2.  
  3.  
  4. aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss((((3333ddddmmmm))))                                            aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      afGetMarkIDs - get the number and list of marker ID's for an audio track
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiiooooffffiiiilllleeee....hhhh>>>>
  13.  
  14.      iiiinnnntttt aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt ttttrrrraaaacccckkkkiiiidddd,,,, iiiinnnntttt mmmmaaaarrrrkkkkiiiiddddssss[[[[]]]]))))
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  17.      _f_i_l_e      is an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure, created when an audio file was
  18.                opened by a call to aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm).
  19.  
  20.      _t_r_a_c_k_i_d   is an integer which identifies an audio track contained in
  21.                _f_i_l_e.  All currently supported file formats contain exactly one
  22.                track, so always use the constant value AAAAFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTRRRRAAAACCCCKKKK for
  23.                now.
  24.  
  25.      _m_a_r_k_i_d_s   is an array of integer locations used to return a list of
  26.                unique positive marker id's which can be used to reference the
  27.                marker structures for _t_r_a_c_k.
  28.  
  29. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  30.      aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss(((()))) returns a nonnegative integer count of the number of
  31.      marker structures in the specified audio track, or -1 in case of error.
  32.  
  33.      For AIFF/AIFF-C files, the number of marker structures in the
  34.      AAAAFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTRRRRAAAACCCCKKKK may be from 0 to 65535.
  35.  
  36. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  37.      aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss(((()))) returns the number of marker structures contained in the
  38.      audio track given by _t_r_a_c_k_i_d, as well as a list of integer id's which can
  39.      be used to reference the markers individually.
  40.  
  41.      In the current version of the AF, markers are used to store the locations
  42.      of loop endpoints in AIFF-C (AIFF) files only.
  43.  
  44.      Typically, you call aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss(((()))) twice.  The first time, you pass it a
  45.      null _m_a_r_k_i_d_s pointer and just check the return value.
  46.  
  47.      The return value tells you how many locations to allocate in the
  48.      _m_a_r_k_i_d_s[] array, which you pass back to aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss(((()))) to obtain a list
  49.      of mark ID's.
  50.  
  51.      You can then use these id's to reference the individual markers and
  52.      obtain information about them such as marker position and associated name
  53.      string.
  54.  
  55. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  56.      This function may return any configuration or number of marks just as it
  57.      may with an AIFF/AIFF-C file.  Apps should be written to expect and
  58.      ignore marks they do not understand.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss((((3333ddddmmmm))))                                            aaaaffffGGGGeeeettttMMMMaaaarrrrkkkkIIIIDDDDssss((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  75.      afOpenFile(3dm), afGetMarkPosition(3dm), afGetMarkName(3dm),
  76.      afInitMarkIDs(3dm)
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.